Пульт.Онлайн /

var_get

Получение текущих статусов переменных

Параметры запроса

  • pult_apikey (строка, обязательный) - API-ключ.
  • vars: (Опционально) Идентификатор запрашиваемой переменной или массив идентификаторов. Параметр принимает глобальное имя или индекс одной переменной, или массив с глобальными именами или индексами множества переменных. Например: ["P1_N1_var1","P1_N2_var1",210,211,...]
  • nodes: (Опционально) Идентификатор узла или массив идентификаторов узлов. Параметр принимает путь или префикс одного узла, или массив с путями или префиксами множества узлов. При использовании этого параметра будут возвращены статусы всех переменных перечисленных узлов. Например: ["P1_N1","P1_N2","/projects/Проект1.project/nodes/Узел1.node",...]

Возвращаемые значения

  • Массив статусов переменных. Каждый статус передается в виде массива следующего содержания: [<var_name>,<time>,<value>,<error>,<payload>], где:
    • var_name: глобальное имя переменной
    • time: время последнего изменения
    • value: последнее достоверное значение
    • error: последняя ошибка (если есть)
    • payload: полезная нагрузка (если есть)

Особенности

  • Для гарантированного получения актуального статуса запрашиваемых переменных необходимо, чтобы сервер постоянно был подписан на запрашиваемые переменные. Сервер в нормальном режиме подписывается только на следующие переменные:

    • аварийные переменные
    • переменные с включенной опцией тренд
    • открытые на мнемосхемах переменные
    • переменные с принудительной подпиской

    Убедитесь, что переменная наблюдается сервером одним из указанных выше способов. Вы также можете включить для сервера принудительную подписку на все переменные (см. параметр watch_all в настройках сервера).

  • Если запрашиваемая переменная не найдена или у инициатора запроса отсутствует к ней доступ, статус такой переменной включается в массив ответа как null, ошибка не генерируется.

Примеры

https://webscada.ru/api/var_get?pult_apikey=31269DCE4F983A31FBE8B88DF67CDAE2&@vars=["P6_N4_temp_outdoor","P6_N5_temp_outdoor","P6_N6_temp_outdoor"]

https://webscada.ru/api/var_get?pult_apikey=31269DCE4F983A31FBE8B88DF67CDAE2&@nodes=["P6_N4","P6_N5","/projects/Приточная вентиляция.project/nodes/ЩУВ1.node"]

  Email
  SMS
   fdb_list
   fdb_load
   fdb_move
   fdb_paths
   node_list
   subscribe
   var_get
   var_list
   var_set